<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width, height=device-height, initial-scale=1, user-scalable=no">
  <meta name="description" content="API docs for the UuidValue class from the uuid_value library, for the Dart programming language.">
  <title>UuidValue class - uuid_value library - Dart API</title>


  
  <link rel="preconnect" href="https://fonts.gstatic.com">
  <link href="https://fonts.googleapis.com/css2?family=Roboto+Mono:ital,wght@0,300;0,400;0,500;0,700;1,400&display=swap" rel="stylesheet">
  <link href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,GRAD@48,400,0,0" rel="stylesheet">
  
  <link rel="stylesheet" href="../static-assets/github.css?v1">
  <link rel="stylesheet" href="../static-assets/styles.css?v1">
  <link rel="icon" href="../static-assets/favicon.png?v1">

  
</head>


<body data-base-href="../" data-using-base-href="false" class="light-theme">

<div id="overlay-under-drawer"></div>

<header id="title">
  <span id="sidenav-left-toggle" class="material-symbols-outlined" role="button" tabindex="0">menu</span>
  <ol class="breadcrumbs gt-separated dark hidden-xs">
    <li><a href="../index.html">uuid</a></li>
    <li><a href="../uuid_value/uuid_value-library.html">uuid_value</a></li>
    <li class="self-crumb">UuidValue class</li>
  </ol>
  <div class="self-name">UuidValue</div>
  <form class="search navbar-right" role="search">
    <input type="text" id="search-box" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
  </form>
  <div class="toggle" id="theme-button">
    <label for="theme">
      <input type="checkbox" id="theme" value="light-theme">
      <span id="dark-theme-button" class="material-symbols-outlined">
        brightness_4
      </span>
      <span id="light-theme-button" class="material-symbols-outlined">
        brightness_5
      </span>
    </label>
  </div>
</header>
<main>

  <div
      id="dartdoc-main-content"
      class="main-content"
      data-above-sidebar="uuid_value&#47;uuid_value-library-sidebar.html"
      data-below-sidebar="uuid_value&#47;UuidValue-class-sidebar.html">
      <div>
<h1><span class="kind-class">UuidValue</span> class 
 
</h1></div>

    


    <section>
      <dl class="dl-horizontal">
        

        
        



        
  <dt>Annotations</dt>
  <dd>
    <ul class="annotation-list clazz-relationships">
        <li>@<a href="https://pub.dev/documentation/meta/1.11.0/meta/experimental-constant.html">experimental</a></li>
    </ul>
  </dd>


      </dl>
    </section>

    
  <section class="summary offset-anchor" id="constructors">
    <h2>Constructors</h2>

    <dl class="constructor-summary-list">
        <dt id="UuidValue" class="callable">
          <span class="name"><a class="deprecated" href="../uuid_value/UuidValue/UuidValue.html">UuidValue</a></span><span class="signature">(<span class="parameter" id="-param-uuid"><span class="type-annotation"><a href="https://api.dart.dev/stable/3.1.3/dart-core/String-class.html">String</a></span> <span class="parameter-name">uuid</span></span>)</span>
        </dt>
        <dd>
          Takes in a string representation of a <a href="../uuid_value/UuidValue/uuid.html">uuid</a> to wrap.
            <div class="constructor-modifier features">const</div>
        </dd>
        <dt id="UuidValue.fromByteList" class="callable">
          <span class="name"><a href="../uuid_value/UuidValue/UuidValue.fromByteList.html">UuidValue.fromByteList</a></span><span class="signature">(<span class="parameter" id="fromByteList-param-byteList"><span class="type-annotation"><a href="https://api.dart.dev/stable/3.1.3/dart-typed_data/Uint8List-class.html">Uint8List</a></span> <span class="parameter-name">byteList</span>, </span><span class="parameter" id="fromByteList-param-offset">{<span class="type-annotation"><a href="https://api.dart.dev/stable/3.1.3/dart-core/int-class.html">int</a>?</span> <span class="parameter-name">offset</span>}</span>)</span>
        </dt>
        <dd>
          fromByteList() creates a UuidValue from a <a href="https://api.dart.dev/stable/3.1.3/dart-typed_data/Uint8List-class.html">Uint8List</a> of bytes.
            <div class="constructor-modifier features">factory</div>
        </dd>
        <dt id="UuidValue.fromList" class="callable">
          <span class="name"><a href="../uuid_value/UuidValue/UuidValue.fromList.html">UuidValue.fromList</a></span><span class="signature">(<span class="parameter" id="fromList-param-byteList"><span class="type-annotation"><a href="https://api.dart.dev/stable/3.1.3/dart-core/List-class.html">List</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="https://api.dart.dev/stable/3.1.3/dart-core/int-class.html">int</a></span>&gt;</span></span> <span class="parameter-name">byteList</span>, </span><span class="parameter" id="fromList-param-offset">{<span class="type-annotation"><a href="https://api.dart.dev/stable/3.1.3/dart-core/int-class.html">int</a>?</span> <span class="parameter-name">offset</span>}</span>)</span>
        </dt>
        <dd>
          fromList() creates a UuidValue from a <a href="https://api.dart.dev/stable/3.1.3/dart-core/List-class.html">List&lt;int&gt;</a> of bytes.
            <div class="constructor-modifier features">factory</div>
        </dd>
        <dt id="UuidValue.fromString" class="callable">
          <span class="name"><a href="../uuid_value/UuidValue/UuidValue.fromString.html">UuidValue.fromString</a></span><span class="signature">(<span class="parameter" id="fromString-param-uuid"><span class="type-annotation"><a href="https://api.dart.dev/stable/3.1.3/dart-core/String-class.html">String</a></span> <span class="parameter-name">uuid</span></span>)</span>
        </dt>
        <dd>
          fromString() creates a UuidValue from a <a href="https://api.dart.dev/stable/3.1.3/dart-core/String-class.html">String</a> with no validation.
            <div class="constructor-modifier features">factory</div>
        </dd>
        <dt id="UuidValue.raw" class="callable">
          <span class="name"><a href="../uuid_value/UuidValue/UuidValue.raw.html">UuidValue.raw</a></span><span class="signature">(<span class="parameter" id="raw-param-uuid"><span class="type-annotation"><a href="https://api.dart.dev/stable/3.1.3/dart-core/String-class.html">String</a></span> <span class="parameter-name">uuid</span></span>)</span>
        </dt>
        <dd>
          Creates a UuidValue by taking directly the internal string representation of the <a href="../uuid_value/UuidValue/uuid.html">uuid</a>,
which is expected to be lowercase.
            <div class="constructor-modifier features">const</div>
        </dd>
        <dt id="UuidValue.withValidation" class="callable">
          <span class="name"><a href="../uuid_value/UuidValue/UuidValue.withValidation.html">UuidValue.withValidation</a></span><span class="signature">(<span class="parameter" id="withValidation-param-uuid"><span class="type-annotation"><a href="https://api.dart.dev/stable/3.1.3/dart-core/String-class.html">String</a></span> <span class="parameter-name">uuid</span>, </span><span class="parameter" id="withValidation-param-validationMode">[<span class="type-annotation"><a href="../enums/ValidationMode.html">ValidationMode</a></span> <span class="parameter-name">validationMode</span> = <span class="default-value">ValidationMode.strictRFC4122</span>]</span>)</span>
        </dt>
        <dd>
          withValidation() creates a UuidValue from a <code>uuid</code> string.
Optionally, you can provide a <code>validationMode</code> to use when validating
the uuid string.
Throws <a href="https://api.dart.dev/stable/3.1.3/dart-core/FormatException-class.html">FormatException</a> if the UUID is invalid.
            <div class="constructor-modifier features">factory</div>
        </dd>
    </dl>
  </section>

    <section class="summary offset-anchor" id="instance-properties">
      <h2>Properties</h2>

      <dl class="properties">
        <dt id="hashCode" class="property">
  <span class="name"><a href="../uuid_value/UuidValue/hashCode.html">hashCode</a></span>
  <span class="signature">&#8594; <a href="https://api.dart.dev/stable/3.1.3/dart-core/int-class.html">int</a></span> 

</dt>
<dd>
  The hash code for this object.
  <div class="features"><span class="feature">read-only</span><span class="feature">override</span></div>

</dd>

        <dt id="runtimeType" class="property inherited">
  <span class="name"><a href="https://api.dart.dev/stable/3.1.3/dart-core/Object/runtimeType.html">runtimeType</a></span>
  <span class="signature">&#8594; <a href="https://api.dart.dev/stable/3.1.3/dart-core/Type-class.html">Type</a></span> 

</dt>
<dd class="inherited">
  A representation of the runtime type of the object.
  <div class="features"><span class="feature">read-only</span><span class="feature">inherited</span></div>

</dd>

        <dt id="time" class="property">
  <span class="name"><a href="../uuid_value/UuidValue/time.html">time</a></span>
  <span class="signature">&#8594; <a href="https://api.dart.dev/stable/3.1.3/dart-core/int-class.html">int</a></span> 

</dt>
<dd>
  
  <div class="features"><span class="feature">read-only</span></div>

</dd>

        <dt id="uuid" class="property">
  <span class="name"><a href="../uuid_value/UuidValue/uuid.html">uuid</a></span>
  <span class="signature">&#8594; <a href="https://api.dart.dev/stable/3.1.3/dart-core/String-class.html">String</a></span> 

</dt>
<dd>
  
  <div class="features"><span class="feature">final</span></div>

</dd>

        <dt id="version" class="property">
  <span class="name"><a href="../uuid_value/UuidValue/version.html">version</a></span>
  <span class="signature">&#8594; <a href="https://api.dart.dev/stable/3.1.3/dart-core/int-class.html">int</a></span> 

</dt>
<dd>
  
  <div class="features"><span class="feature">read-only</span></div>

</dd>

      </dl>
    </section>

    
  <section
      class="summary offset-anchor"
      id="instance-methods">
    <h2>Methods</h2>
    <dl class="callables">
        <dt id="equals" class="callable">
  <span class="name"><a href="../uuid_value/UuidValue/equals.html">equals</a></span><span class="signature">(<wbr><span class="parameter" id="equals-param-other"><span class="type-annotation"><a href="../uuid_value/UuidValue-class.html">UuidValue</a></span> <span class="parameter-name">other</span></span>)
    <span class="returntype parameter">&#8594; <a href="https://api.dart.dev/stable/3.1.3/dart-core/bool-class.html">bool</a></span>
  </span>
  

</dt>
<dd>
  
  

</dd>

        <dt id="noSuchMethod" class="callable inherited">
  <span class="name"><a href="https://api.dart.dev/stable/3.1.3/dart-core/Object/noSuchMethod.html">noSuchMethod</a></span><span class="signature">(<wbr><span class="parameter" id="noSuchMethod-param-invocation"><span class="type-annotation"><a href="https://api.dart.dev/stable/3.1.3/dart-core/Invocation-class.html">Invocation</a></span> <span class="parameter-name">invocation</span></span>)
    <span class="returntype parameter">&#8594; dynamic</span>
  </span>
  

</dt>
<dd class="inherited">
  Invoked when a nonexistent method or property is accessed.
  <div class="features"><span class="feature">inherited</span></div>

</dd>

        <dt id="toBytes" class="callable">
  <span class="name"><a href="../uuid_value/UuidValue/toBytes.html">toBytes</a></span><span class="signature">(<wbr><span class="parameter" id="toBytes-param-validate">{<span class="type-annotation"><a href="https://api.dart.dev/stable/3.1.3/dart-core/bool-class.html">bool</a></span> <span class="parameter-name">validate</span> = <span class="default-value">false</span>}</span>)
    <span class="returntype parameter">&#8594; <a href="https://api.dart.dev/stable/3.1.3/dart-typed_data/Uint8List-class.html">Uint8List</a></span>
  </span>
  

</dt>
<dd>
  
  

</dd>

        <dt id="toString" class="callable">
  <span class="name"><a href="../uuid_value/UuidValue/toString.html">toString</a></span><span class="signature">(<wbr>)
    <span class="returntype parameter">&#8594; <a href="https://api.dart.dev/stable/3.1.3/dart-core/String-class.html">String</a></span>
  </span>
  

</dt>
<dd>
  A string representation of this object.
  <div class="features"><span class="feature">override</span></div>

</dd>

        <dt id="validate" class="callable">
  <span class="name"><a href="../uuid_value/UuidValue/validate.html">validate</a></span><span class="signature">(<wbr><span class="parameter" id="validate-param-validationMode">[<span class="type-annotation"><a href="../enums/ValidationMode.html">ValidationMode</a></span> <span class="parameter-name">validationMode</span> = <span class="default-value">ValidationMode.strictRFC4122</span>]</span>)
    <span class="returntype parameter">&#8594; void</span>
  </span>
  

</dt>
<dd>
  validate() validates the internal string representation of the uuid.
Optionally, you can provide a <code>validationMode</code> to use when validating
the uuid string.
Throws <a href="https://api.dart.dev/stable/3.1.3/dart-core/FormatException-class.html">FormatException</a> if the UUID is invalid.
  

</dd>

    </dl>
  </section>
    
  <section
      class="summary offset-anchor"
      id="operators">
    <h2>Operators</h2>
    <dl class="callables">
        <dt id="operator ==" class="callable">
  <span class="name"><a href="../uuid_value/UuidValue/operator_equals.html">operator ==</a></span><span class="signature">(<wbr><span class="parameter" id="==-param-other"><span class="type-annotation"><a href="https://api.dart.dev/stable/3.1.3/dart-core/Object-class.html">Object</a></span> <span class="parameter-name">other</span></span>)
    <span class="returntype parameter">&#8594; <a href="https://api.dart.dev/stable/3.1.3/dart-core/bool-class.html">bool</a></span>
  </span>
  

</dt>
<dd>
  The equality operator.
  <div class="features"><span class="feature">override</span></div>

</dd>

    </dl>
  </section>
    
    
    

  <section class="summary offset-anchor" id="constants">
    <h2>Constants</h2>

    <dl class="properties">
        <dt id="dns" class="constant">
    <span class="name "><a href="../uuid_value/UuidValue/dns-constant.html">dns</a></span>
  <span class="signature">&#8594; const <a href="../uuid_value/UuidValue-class.html">UuidValue</a></span>
  

</dt>
<dd>
  
  

    <div>
      <span class="signature"><code>UuidValue.raw(Uuid.NAMESPACE_DNS)</code></span>
    </div>
</dd>

        <dt id="nil" class="constant">
    <span class="name "><a href="../uuid_value/UuidValue/nil-constant.html">nil</a></span>
  <span class="signature">&#8594; const <a href="../uuid_value/UuidValue-class.html">UuidValue</a></span>
  

</dt>
<dd>
  
  

    <div>
      <span class="signature"><code>UuidValue.raw(Uuid.NAMESPACE_NIL)</code></span>
    </div>
</dd>

        <dt id="oid" class="constant">
    <span class="name "><a href="../uuid_value/UuidValue/oid-constant.html">oid</a></span>
  <span class="signature">&#8594; const <a href="../uuid_value/UuidValue-class.html">UuidValue</a></span>
  

</dt>
<dd>
  
  

    <div>
      <span class="signature"><code>UuidValue.raw(Uuid.NAMESPACE_OID)</code></span>
    </div>
</dd>

        <dt id="url" class="constant">
    <span class="name "><a href="../uuid_value/UuidValue/url-constant.html">url</a></span>
  <span class="signature">&#8594; const <a href="../uuid_value/UuidValue-class.html">UuidValue</a></span>
  

</dt>
<dd>
  
  

    <div>
      <span class="signature"><code>UuidValue.raw(Uuid.NAMESPACE_URL)</code></span>
    </div>
</dd>

        <dt id="x500" class="constant">
    <span class="name "><a href="../uuid_value/UuidValue/x500-constant.html">x500</a></span>
  <span class="signature">&#8594; const <a href="../uuid_value/UuidValue-class.html">UuidValue</a></span>
  

</dt>
<dd>
  
  

    <div>
      <span class="signature"><code>UuidValue.raw(Uuid.NAMESPACE_X500)</code></span>
    </div>
</dd>

    </dl>
  </section>

  </div> <!-- /.main-content -->

  <div id="dartdoc-sidebar-left" class="sidebar sidebar-offcanvas-left">
    <!-- The search input and breadcrumbs below are only responsively visible at low resolutions. -->
<header id="header-search-sidebar" class="hidden-l">
  <form class="search-sidebar" role="search">
    <input type="text" id="search-sidebar" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
  </form>
</header>

<ol class="breadcrumbs gt-separated dark hidden-l" id="sidebar-nav">
    <li><a href="../index.html">uuid</a></li>
    <li><a href="../uuid_value/uuid_value-library.html">uuid_value</a></li>
    <li class="self-crumb">UuidValue class</li>
</ol>


    <!--<h5>uuid_value library</h5>-->
    <div id="dartdoc-sidebar-left-content"></div>
  </div>

  <div id="dartdoc-sidebar-right" class="sidebar sidebar-offcanvas-right">
  </div><!--/.sidebar-offcanvas-->

</main>

<footer>
  <span class="no-break">
    uuid
      4.2.1
  </span>

  
</footer>



<script src="../static-assets/highlight.pack.js?v1"></script>
<script src="../static-assets/docs.dart.js"></script>



</body>

</html>

